<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class PelEntryWindowsString</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="../media/images/Class_logo.png"
														alt=" Class"
														title=" Class"
														style="vertical-align: middle"> PelEntryWindowsString</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-vars">Vars</a>
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Class used to manipulate strings in the format Windows XP uses.</p>
<p class="description"><p>When examining the file properties of an image in Windows XP one  can fill in title, comment, author, keyword, and subject fields.  Filling those fields and pressing OK will result in the data being  written into the Exif data in the image.</p><p>The data is written in a non-standard format and can thus not be  loaded directly --- this class is needed to translate it into  normal strings.</p><p>It is important that entries from this class are only created with  the <a href="../PEL/PelTag.html#constXP_TITLE">PelTag::XP_TITLE</a>, <a href="../PEL/PelTag.html#constXP_COMMENT">PelTag::XP_COMMENT</a>, <a href="../PEL/PelTag.html#constXP_AUTHOR">PelTag::XP_AUTHOR</a>, PelTag::XP_KEYWORD, and <a href="../PEL/PelTag.html#constXP_SUBJECT">PelTag::XP_SUBJECT</a> tags.  If another tag is used the data will no  longer be correctly decoded when reloaded with PEL. (The data will  be loaded as an <a href="../PEL/PelEntryByte.html">PelEntryByte</a> entry, which isn't as useful.)</p><p>This class is to be used as in  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$entry&nbsp;</span>=&nbsp;<span class="src-var">$ifd</span><span class="src-sym">-&gt;</span><span class="src-id">getEntry</span><span class="src-sym">(</span><span class="src-id"><a href="../PEL/PelTag.html">PelTag</a></span><span class="src-sym">::</span><span class="src-id">XP_TITLE</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;print<span class="src-sym">(</span><span class="src-var">$entry</span><span class="src-sym">-&gt;</span><a href="../PEL/PelEntryWindowsString.html#methodgetValue">getValue</a><span class="src-sym">(</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-var">$entry</span><span class="src-sym">-&gt;</span><a href="../PEL/PelEntryWindowsString.html#methodsetValue">setValue</a><span class="src-sym">(</span><span class="src-str">'My&nbsp;favorite&nbsp;cat'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Martin Geisler &lt;<a href="mailto:mgeisler@users.sourceforge.net">mgeisler@users.sourceforge.net</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_PelEntryByte.php.html">/PelEntryByte.php</a> (line <span class="field"><a href="../__filesource/fsource_PEL__PelEntryByte.php.html#a190">190</a></span>)
		</p>
		
				
		<pre><a href="../PEL/PelEntry.html">PelEntry</a>
   |
   --PelEntryWindowsString</pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-vars">Vars</a>
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																<div class="method-definition">
					<img src="../media/images/Constructor.png" alt=" "/>
											<span class="method-result">PelEntryWindowsString</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$tag</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getText" title="details" class="method-name">getText</a>
											([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$brief</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">string</span>
										<a href="#getValue" title="details" class="method-name">getValue</a>
										()
									</div>
																<div class="method-definition">
					<img src="../media/images/Method.png" alt=" "/>
											<span class="method-result">void</span>
										<a href="#setValue" title="details" class="method-name">setValue</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../PEL/PelEntry.html">PelEntry</a></span></p>
					<blockquote>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$bytes">PelEntry::$bytes</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$components">PelEntry::$components</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$format">PelEntry::$format</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$ifd_type">PelEntry::$ifd_type</a></span><br>
							</span>
													<img src="../media/images/Variable.png" />
							<span class="var-title">
								<span class="var-name"><a href="../PEL/PelEntry.html#var$tag">PelEntry::$tag</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-vars">Vars</a>
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Constructor.png" />
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryByte.php.html#a217">217</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Make a new PelEntry that can hold a Windows XP specific string.</p>
	
	<div class="method-signature">
		<span class="method-result">PelEntryWindowsString</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$tag</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$tag</span><span class="var-description">: the tag which this entry represents.  This should be  one of <a href="../PEL/PelTag.html#constXP_TITLE">PelTag::XP_TITLE</a>, <a href="../PEL/PelTag.html#constXP_COMMENT">PelTag::XP_COMMENT</a>,  <a href="../PEL/PelTag.html#constXP_AUTHOR">PelTag::XP_AUTHOR</a>, PelTag::XP_KEYWORD, and <a href="../PEL/PelTag.html#constXP_SUBJECT">PelTag::XP_SUBJECT</a> tags.  If another tag is used, then this  entry will be incorrectly reloaded as a <a href="../PEL/PelEntryByte.html">PelEntryByte</a>.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span><span class="var-description">: the string that this entry will represent.  It will  be passed to <a href="../PEL/PelEntryWindowsString.html#methodsetValue">setValue</a> and thus has to obey its  requirements.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetText" id="getText"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getText</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryByte.php.html#a269">269</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the string of the entry.</p>
<p class="description"><p>This methods returns the same as <a href="../PEL/PelEntryWindowsString.html#methodgetValue">getValue</a>.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the string held, without any extra NULL  characters.  The string will be the same as the one given to  <a href="../PEL/PelEntryWindowsString.html#methodsetValue">setValue</a> or to the <a href="../PEL/PelEntryWindowsString.html#method__construct">constructor</a>.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getText
		</span>
					([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$brief</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$brief</span><span class="var-description">: not used.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PEL/PelEntry.html#methodgetText">PelEntry::getText()</a></dt>
						<dd>Get the value of this entry as text.</dd>
					</dl>
			
	</div>
<a name="methodgetValue" id="getValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">getValue</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryByte.php.html#a253">253</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the string of the entry.</p>
	<ul class="tags">
				<li><span class="field">return:</span> the string held, without any extra NULL  characters.  The string will be the same as the one given to  <a href="../PEL/PelEntryWindowsString.html#methodsetValue">setValue</a> or to the <a href="../PEL/PelEntryWindowsString.html#method__construct">constructor</a>.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getValue
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PEL/PelEntry.html#methodgetValue">PelEntry::getValue()</a></dt>
						<dd>Get the value of this entry.</dd>
					</dl>
			
	</div>
<a name="methodsetValue" id="setValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="../media/images/Method.png" />
		<span class="method-title">setValue</span> (line <span class="line-number"><a href="../__filesource/fsource_PEL__PelEntryByte.php.html#a233">233</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Give the entry a new value.</p>
<p class="description"><p>This will overwrite the previous value.  The value can be  retrieved later with the <a href="../PEL/PelEntryWindowsString.html#methodgetValue">getValue</a> method.</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setValue
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span><span class="var-description">: the new value of the entry.  This should be use the  Latin-1 encoding and be given without any extra NULL characters.</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PEL/PelEntry.html#methodsetValue">PelEntry::setValue()</a></dt>
						<dd>Set the value of this entry.</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../PEL/PelEntry.html">PelEntry</a></span></p>
					<blockquote>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetBytes">PelEntry::getBytes()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetComponents">PelEntry::getComponents()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetFormat">PelEntry::getFormat()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetIfdType">PelEntry::getIfdType()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetTag">PelEntry::getTag()</a></span><br>
													<img src="../media/images/AbstractMethod.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetText">PelEntry::getText()</a></span><br>
													<img src="../media/images/AbstractMethod.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodgetValue">PelEntry::getValue()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodsetIfdType">PelEntry::setIfdType()</a></span><br>
													<img src="../media/images/AbstractMethod.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#methodsetValue">PelEntry::setValue()</a></span><br>
													<img src="../media/images/Method.png" alt=" "/>
							<span class="method-name"><a href="../PEL/PelEntry.html#method__toString">PelEntry::__toString()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Tue, 19 Dec 2006 01:08:19 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
                <a target="_top" href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=108380&amp;type=1" width="88" height="31" border="0" align="right" alt="SourceForge.net Logo" /></a>
	</p>
	</div></body>
</html>